/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

package org.grails.scaffolding.model.property

import org.grails.datastore.mapping.model.PersistentProperty

/**
 * A factory to create instances of {@link DomainProperty}
 *
 * @author James Kleeh
 */
interface DomainPropertyFactory {

    /**
     * @param persistentProperty The persistent property
     * @return The {@link DomainProperty} representing the {@link PersistentProperty}
     */
    DomainProperty build(PersistentProperty persistentProperty)

    /**
     * @param rootProperty The root property. Typically an instance of {@link org.grails.datastore.mapping.model.types.Embedded}
     * @param persistentProperty The persistent property
     * @return The {@link DomainProperty} representing the {@link PersistentProperty}
     */
    DomainProperty build(PersistentProperty rootProperty, PersistentProperty persistentProperty)

}
